Skip to content

Conversation

@pytorchbot
Copy link
Collaborator

This PR was created by the merge bot to help merge the original PR into the main branch.
ghstack PR number: #13474 by @SS-JIA
^ Please use this as the source of truth for the PR details, comments, and reviews
ghstack PR base: https://github.com/pytorch/executorch/tree/gh/SS-JIA/292/base
ghstack PR head: https://github.com/pytorch/executorch/tree/gh/SS-JIA/292/head
Merge bot PR base: https://github.com/pytorch/executorch/tree/gh/SS-JIA/291/orig
Merge bot PR head: https://github.com/pytorch/executorch/tree/gh/SS-JIA/292/orig
@diff-train-skip-merge

ssjia added 4 commits August 18, 2025 10:28
…elines()` to `prepare()`

Title says it all; `prepare()` is a more appropriate place for this action than `prepare_pipelines()`.

## Motivation

Fix potential floating point exception (divide-by-zero) during tests.

Some tests don't call `prepare_pipelines()`, which means `execute_threshold_node_count_` is unititialized, causing a divide by zero in execute when trying to modulo with `execute_threshold_node_count_`

Differential Revision: [D80468138](https://our.internmc.facebook.com/intern/diff/D80468138/)

ghstack-source-id: 303779589
Pull Request resolved: #13478
Pull Request resolved: #13472




Allow VulkanBackend to load constant tensors from the NamedDataMap instead of the constant data section of the delegate blob.

## Motivation

This enables several key results:

* Unblocks delegate retargetability with other backends
* Allows reducing peak memory usage when loading models by freeing constant weight data as it gets moved to the GPU

## Changes

* Allow `TensorRef` to be constructed with a `FreeableBuffer` rvalue
* Add ability to load constant data from `NamedDataMap` in `VulkanBackend.cpp`
* When prepacking, free the constant data pointer once it's been copied to the staging buffer
ghstack-source-id: 303830113

Differential Revision: [D80460035](https://our.internmc.facebook.com/intern/diff/D80460035/)
Pull Request resolved: #13473



When exporting models to Vulkan backend, save constant tensors in the NamedDataMap instead of the constant data section of the delegate header.

## Motivation

Prevent screen blackout (Llama 3.2 1B) / device crash (Llama 3.2 3B) when running Llama 3.2 models on Samsung Galaxy S24. This behaviour is related to high peak memory usage when loading the model. For more information, see the top diff/PR in the stack.

## Context

This change is based on the equivalent change D70315207/#9153 in XNNPACK.
ghstack-source-id: 303830114

Differential Revision: [D80460034](https://our.internmc.facebook.com/intern/diff/D80460034/)
Pull Request resolved: #13474



* Allocate memory for weight tensors right before the prepacking shader is dispatched, rather than while building the graph
* Move allocation of shared objects (i.e. memory for intermediate tensors) to occur after prepacking

## Motivation

Prevent screen blackout (Llama 3.2 1B) / device crash (Llama 3.2 3B) when running Llama 3.2 models on Samsung Galaxy S24. This behaviour is related to high peak memory usage when loading the model.

## Full Context

During model loading, Vulkan delegate needs to store 3 copies of constant data in memory at various points:

* source data obtained from loading the model
* staging buffer
* GPU texture/buffer

The general rationale of this change is to allocate memory for each copy only when necessary to minimize the "overlap" when all 3 exist at once.

### Current Order of operations

Legend:
* `W` represents total weight nbytes
* `w` represents weight nbytes for one tensor
* `A` represents total activations nbytes
* `M` represents approximation of total memory footprint

First, model file is loaded

Then, when building compute graph, for each weight tensor:
1. Weight data is loaded from NamedDataMap (`M = W`)
2. GPU texture/buffer for weight is initialized + memory allocated (`M = 2W`)
3. After building the graph, `graph->prepare()` is called which currently allocates memory for the activation tensors as well (`M = 2W + A`)

Then, during the prepacking stage for each weight tensor, each weight tensor is copied individually:
1. Staging buffer initialized (`M = 2W + A + w`)
2. Copy CPU weight data to staging + CPU Weight data is freed (`M = 2W + A`)
3. Compute shader dispatch to copy staging to GPU texture/buffer + free staging buffer (`M = 2W + A - w`)

The peak usage in mainline will be `M = 2W + A + w`

### Revised order of operations

This change revises the order of operations:

1. Weight data is loaded from NamedDataMap (`M = W`)
2. GPU texture/buffer for weight is initialized, but **memory is not allocated** (`M = W`)

Then, during the prepacking stage for each weight tensor, each weight tensor is copied individually:
1. Staging buffer initialized (`M = W + w`)
2. **Memory allocated for GPU texture/buffer** (`M = W + 2w`)
3. Copy CPU weight data to staging + CPU Weight data is freed (`M = W + w`)
4. Compute shader dispatch to copy staging to GPU texture/buffer + free staging buffer (`M = W`)

**Then, after all prepacking operations complete, only then is Activation memory allocated** (`M = W + A`)

Under this scheme, peak memory is reduced to `M = W + A` (or alternatively `M = W + 2w` if `2w > A`) which is (or at least very close to) the theoretical minimum.
ghstack-source-id: 303862303

Differential Revision: [D80460033](https://our.internmc.facebook.com/intern/diff/D80460033/)
@pytorchbot pytorchbot requested a review from SS-JIA as a code owner August 19, 2025 02:24
@pytorch-bot
Copy link

pytorch-bot bot commented Aug 19, 2025

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/executorch/13501

Note: Links to docs will display an error until the docs builds have been completed.

⏳ 9 Pending, 1 Unrelated Failure

As of commit 6c18621 with merge base 5ff0208 (image):

BROKEN TRUNK - The following job failed but were present on the merge base:

👉 Rebase onto the `viable/strict` branch to avoid these failures

  • pull / test-binary-size-linux-gcc / linux-job (gh) (trunk failure)
    /pytorch/executorch/kernels/portable/cpu/op_stack.cpp:129:26: error: comparison of integer expressions of different signedness: ‘size_t’ {aka ‘long unsigned int’} and ‘ssize_t’ {aka ‘long int’} [-Werror=sign-compare]

This comment was automatically generated by Dr. CI and updates every 15 minutes.

@meta-cla meta-cla bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Aug 19, 2025
Base automatically changed from gh/SS-JIA/291/orig to main August 19, 2025 03:06
@SS-JIA SS-JIA merged commit 85e5b6e into main Aug 19, 2025
200 of 202 checks passed
agrima1304 pushed a commit to agrima1304/executorch that referenced this pull request Aug 26, 2025
…orch#13501)

Summary:
* Allocate memory for weight tensors right before the prepacking shader is dispatched, rather than while building the graph
* Move allocation of shared objects (i.e. memory for intermediate tensors) to occur after prepacking

## Motivation

Prevent screen blackout (Llama 3.2 1B) / device crash (Llama 3.2 3B) when running Llama 3.2 models on Samsung Galaxy S24. This behaviour is related to high peak memory usage when loading the model.

## Full Context

During model loading, Vulkan delegate needs to store 3 copies of constant data in memory at various points:

* source data obtained from loading the model
* staging buffer
* GPU texture/buffer

The general rationale of this change is to allocate memory for each copy only when necessary to minimize the "overlap" when all 3 exist at once.

### Current Order of operations

Legend:
* `W` represents total weight nbytes
* `w` represents weight nbytes for one tensor
* `A` represents total activations nbytes
* `M` represents approximation of total memory footprint

First, model file is loaded

Then, when building compute graph, for each weight tensor:
1. Weight data is loaded from NamedDataMap (`M = W`)
2. GPU texture/buffer for weight is initialized + memory allocated (`M = 2W`)
3. After building the graph, `graph->prepare()` is called which currently allocates memory for the activation tensors as well (`M = 2W + A`)

Then, during the prepacking stage for each weight tensor, each weight tensor is copied individually:
1. Staging buffer initialized (`M = 2W + A + w`)
2. Copy CPU weight data to staging + CPU Weight data is freed (`M = 2W + A`)
3. Compute shader dispatch to copy staging to GPU texture/buffer + free staging buffer (`M = 2W + A - w`)

The peak usage in mainline will be `M = 2W + A + w`

### Revised order of operations

This change revises the order of operations:

1. Weight data is loaded from NamedDataMap (`M = W`)
2. GPU texture/buffer for weight is initialized, but **memory is not allocated** (`M = W`)

Then, during the prepacking stage for each weight tensor, each weight tensor is copied individually:
1. Staging buffer initialized (`M = W + w`)
2. **Memory allocated for GPU texture/buffer** (`M = W + 2w`)
3. Copy CPU weight data to staging + CPU Weight data is freed (`M = W + w`)
4. Compute shader dispatch to copy staging to GPU texture/buffer + free staging buffer (`M = W`)

**Then, after all prepacking operations complete, only then is Activation memory allocated** (`M = W + A`)

Under this scheme, peak memory is reduced to `M = W + A` (or alternatively `M = W + 2w` if `2w > A`) which is (or at least very close to) the theoretical minimum.

Test Plan:
## Logging Memory Usage

Using

```
uint64_t getVmRssInKB() {
  std::ifstream statusFile("/proc/self/status");
  std::string l, num;
  while (std::getline(statusFile, l)) {
    if (l.substr(0, 5) == "VmRSS") {
      size_t pos = l.find_first_of("0123456789");
      num = l.substr(pos);
      break;
    }
  }
  uint64_t vmRssInKB = std::stoi(num);
  return vmRssInKB;
}

uint64_t getVmaStatsInKB() {
  auto stats =
      vkcompute::api::context()->adapter_ptr()->vma().get_memory_statistics();
  uint64_t vmaBlockInKB = stats.total.statistics.blockBytes >> 10;
  return vmaBlockInKB;
}
```

to log memory footprint at various points of inference when running the llama_runner binary with Llama 3.2 1B, we can compare the memory footprint with and without these changes.

With changes: P1908051860 (Meta only)

```
Memory usage before model compilation: 1115760 KB (VmRSS), 0 KB (VMA)
Memory usage after graph building: 1924832 KB (VmRSS), 17920 KB (VMA)
Memory usage after graph preparation: 1935312 KB (VmRSS), 17920 KB (VMA)
Memory usage prepack start: 1935312 KB, VMA Block: 17920 KB
Memory usage after prepack operations: 1372376 KB (VmRSS), 2330528 KB (VMA)

Memory usage before execute: 1372804 KB (VmRSS), 2330528 KB (VMA)
Memory usage at end of execute: 1376916 KB (VmRSS), 2330528 KB (VMA)
```

WIthout changes: P1908054759 (Meta only)

```
Memory usage before model compilation: 1114784 KB (VmRSS), 0 KB (VMA)
Memory usage after graph building: 1924432 KB (VmRSS), 962464 KB (VMA)
Memory usage after graph preparation: 1922916 KB (VmRSS), 2326432 KB (VMA)
Memory usage prepack start: 1922916 KB, VMA Block: 2326432 KB
Memory usage after prepack operations: 1359180 KB (VmRSS), 2330528 KB (VMA)

Memory usage before execute: 1359492 KB (VmRSS), 2330528 KB (VMA)
Memory usage at end of execute: 1363636 KB (VmRSS), 2330528 KB (VMA)
```

It is evident how peak memory can be reduced with these changes, as VMA footprint gradually increases while loading the model while VmRss gradually decreases. Without these changes, VMA footprint will reach its peak after initializing the graph.

Visually, it can also be verified that Samsung Galaxy S24's screen no longer blacks out while loading the model.

Differential Revision: [D80460033](https://our.internmc.facebook.com/intern/diff/D80460033)

[ghstack-poisoned]
@SS-JIA SS-JIA deleted the gh/SS-JIA/292/orig branch October 15, 2025 18:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants